package org.ivwsqii.arraylist;

import java.util.*;

/**
 *
 * @author wyl
 * @param <E>
 */
public class MyArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable {


    /**
     * 初始化默认容量。
     */
    private static final int DEFAULT_CAPACITY = 10;
    /**
     * 指定该ArrayList容量为0时，返回该空数组。
     */
    private static final Object[] EMPTY_ELEMENTDATA = {};
    /**
     * 当调用无参构造方法，返回的是该数组。刚创建一个ArrayList 时，其内数据量为0。
     * 它与EMPTY_ELEMENTDATA的区别就是：该数组是默认返回的，而后者是在用户指定容量为0时返回。
     */
    private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
    /**
     * 保存添加到ArrayList中的元素。
     * ArrayList的容量就是该数组的长度。
     * 该值为DEFAULTCAPACITY_EMPTY_ELEMENTDATA 时，当第一次添加元素进入ArrayList中时，数组将扩容值DEFAULT_CAPACITY。
     * 被标记为transient，在对象被序列化的时候不会被序列化。
     */
    private transient Object[] elementData;
    /**
     * ArrayList的实际大小（数组包含的元素个数）。
     * @serial
     */
    private int size;

    /**
     * 构造一个指定初始化容量为capacity的空ArrayList。
     *
     * @param  initialCapacity  ArrayList的指定初始化容量
     * @throws IllegalArgumentException  如果ArrayList的指定初始化容量为负。
     */
    public MyArrayList(int initialCapacity){
        if (initialCapacity > 0){
            this.elementData = new Object[initialCapacity];
        }else if (initialCapacity == 0){
            this.elementData = EMPTY_ELEMENTDATA;
        }else{
            throw new IllegalArgumentException("非法容量参数"+initialCapacity);
        }
    }
    /**
     * 构造一个初始容量为 10 的空列表。
     */
    public MyArrayList(){
        this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
    }
    /**
     * 构造一个包含指定 collection 的元素的列表，这些元素是按照该 collection 的迭代器返回它们的顺序排列的。
     *
     * @param collection 其元素将放置在此列表中的 collection
     * @throws NullPointerException 如果指定的 collection 为 null
     */
    public MyArrayList(Collection<? extends E> collection){
        this.elementData = collection.toArray();
//        使用collection.size()和elementdata.length有区别么  ???
//        if ((this.size =collection.size()) != 0){
        if ((size = elementData.length) != 0){
            if (elementData.getClass() != Object[].class){
                elementData = Arrays.copyOf(elementData,size,Object[].class);
            }
        }else{
            this.elementData = EMPTY_ELEMENTDATA;
        }
    }

    /**
     * 返回list中索引为index的元素
     *
     * @param  index 需要返回的元素的索引
     * @return list中索引为index的元素
     * @throws IndexOutOfBoundsException 如果索引超出size
     */
    @Override
    public E get(int index) {
        rangeCheck(index);
        return elementData(index);
    }
    /**
     * 添加元素到list末尾.
     *
     * @param e 被添加的元素
     * @return true
     */
    public boolean add(E e){
        //检查list容量，如果不够，添加1，保证资源不被浪费
        ensureCapacityInternal(size+1);
        //将新增元素添加到数组的末尾
        elementData[size++] = e;
        return true;
    }

    /**
     * 在制定位置插入元素。当前位置的元素和index之后的元素向后移一位
     * 需要先对元素进行移动，然后完成插入操作，也就意味着该方法有着线性的时间复杂度，即O(n)。
     * @param index 即将插入元素的位置
     * @param element 即将插入的元素
     * @throws IndexOutOfBoundsException 如果索引超出size
     */
    public void add(int index, E element) {
        //越界检查
        rangeCheckForAdd(index);
        //确认list容量，如果不够，容量加1。注意：只加1，保证资源不被浪费
        ensureCapacityInternal(size + 1);  // Increments modCount!!
        // 对数组进行复制处理，目的就是空出index的位置插入element，并将index后的元素位移一个位置
        System.arraycopy(elementData,index,elementData,index+1,size-index);
        //将指定的index位置赋值为element
        elementData[index] = element;
        //实际容量+1
        size++;
    }
    /**
     * 删除list中位置为指定索引index的元素
     * 索引之后的元素向左移一位
     *
     * @param index 被删除元素的索引
     * @return 被删除的元素
     * @throws IndexOutOfBoundsException 如果参数指定索引index>=size，抛出一个越界异常
     */
    public E remove(int index) {
        rangeCheck(index);
        E oldValue = elementData(index);
        // 删除指定元素后，需要左移的元素个数
        int numMoved = size - index - 1;
        if (numMoved > 0){
            System.arraycopy(elementData,index+1,elementData,index,size-index-1);
        }
        // size减一，然后将索引为size-1处的元素置为null。为了让GC起作用，必须显式的为最后一个位置赋null值
        elementData[--size] = null;
        return oldValue;
    }
    /**
     * 替换指定索引的元素
     *
     * @param index 被替换元素的索引
     * @param element 即将替换到指定索引的元素
     * @return 返回被替换的元素
     * @throws IndexOutOfBoundsException 如果参数指定索引index>=size，抛出一个越界异常
     */
    public E set(int index, E element) {
        //检查索引是否越界。如果参数指定索引index>=size，抛出一个越界异常
        rangeCheck(index);

        //记录被替换的元素
        E oldValue = elementData(index);
        //替换元素
        elementData[index] = element;
        //返回被替换的元素
        return oldValue;
    }
    /**
     * 数组容量检查，不够时则进行扩容，只供类内部使用。
     *
     * @param minCapacity    想要的最小容量
     */
    private void ensureCapacityInternal(int minCapacity){
        ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
    }
    /**
     * 数组容量检查，不够时则进行扩容，只供类内部使用
     *
     * @param minCapacity 想要的最小容量
     */
    private void ensureExplicitCapacity(int minCapacity) {

        // 确保指定的最小容量 > 数组缓冲区当前的长度
        if (minCapacity > elementData.length){
            //扩容
            grow(minCapacity);
        }
    }

    /**
     * 计算容量
     */
    private int calculateCapacity(Object[] elementData, int minCapacity) {
        //真正的初始化是在添加第一条数据(即调用add()方法时)完成，此时elementData和DEFAULTCAPACITY_EMPTY_ELEMENTDATA均为空
        //初始化容量小于10的仍为10，大于10的为其本身大小
        if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA){
//            当前数组为空时 进入
            minCapacity = Math.max(minCapacity, DEFAULT_CAPACITY);
        }
        return minCapacity;
    }

    /**
     * 分派给arrays的最大容量
     * 为什么要减去8呢？
     * 因为某些VM会在数组中保留一些头字，尝试分配这个最大存储容量，可能会导致array容量大于VM的limit，最终导致OutOfMemoryError。
     */
    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
    /**
     * 扩容，保证ArrayList至少能存储minCapacity个元素
     * 第一次扩容，逻辑为newCapacity = oldCapacity + (oldCapacity >> 1);即在原有的容量基础上增加一半。第一次扩容后，如果容量还是小于minCapacity，就将容量扩充为minCapacity。
     *
     * @param minCapacity 想要的最小容量
     */
    private void grow(int minCapacity) {
        // 获取当前数组的容量
        int oldCapacity = elementData.length;
        // 扩容。新的容量=当前容量+当前容量/2.即将当前容量增加一半。
        int newCapacity = oldCapacity + (oldCapacity >> 1);
        //如果扩容后，仍然不足所需要的最小容量，则将新的容量赋值为所需最小容量
        if (minCapacity > newCapacity){
            newCapacity = minCapacity;
        }
        //如果扩容后的容量大于临界值，则进行大容量分配
        if (newCapacity > MAX_ARRAY_SIZE){
            newCapacity = hugeCapacity(minCapacity);
        }
        elementData = Arrays.copyOf(elementData,newCapacity);

    }
    /**
     * 进行大容量分配
     */
    private static int hugeCapacity(int minCapacity){
        //如果minCapacity<0，抛出异常
        if (minCapacity < 0){
            throw new OutOfMemoryError();
        }
        //如果想要的容量大于MAX_ARRAY_SIZE，则分配Integer.MAX_VALUE，否则分配MAX_ARRAY_SIZE
       return (minCapacity > MAX_ARRAY_SIZE) ? Integer.MAX_VALUE : MAX_ARRAY_SIZE;

    }

    /**
     * 越界检查。
     * 检查给出的索引index是否越界。
     * 如果越界，抛出运行时异常。
     * 这个方法并不检查index是否合法。比如是否为负数。
     * 如果给出的索引index>=size，抛出一个越界异常
     */
    private void rangeCheck(int index){
        if (index >= size){
            throw new ArrayIndexOutOfBoundsException(outOfBoundsMessage(index));
        }
    }
    private void rangeCheckForAdd(int index){
        if (index > size || index < 0){
            throw new IndexOutOfBoundsException(outOfBoundsMessage(index));
        }
    }

    /**
     * 返回索引为index的元素
     */
    private E elementData(int index){
        return (E) elementData[index];
    }

    /**
     * 提示数组下标越界的信息
     */
    private String outOfBoundsMessage(int index){
        return "Index:"+index+"，Size:"+size;
    }
    /**
     * 返回数组元素的个数
     */
    @Override
    public int size() {
        return size;
    }
}
